CountSubControls

CountSubControls
Header:	Controls.h		Carbon status:	Supported

Obtains the number of embedded controls within a control.

OSErr CountSubControls (
    ControlRef inControl, 
    UInt16 *outNumChildren
);

inControl: A handle to a control whose embedded controls you wish to count.
outNumChildren: On input, a pointer to a signed 16-bit integer value. On return, the value is set to the number of embedded subcontrols.

function result: A result code.

DISCUSSION

The CountSubControls function is useful for iterating over the control hierarchy. You can use the count produced to determine how many subcontrols there are and then call GetIndexedSubControl to get each.

VERSION NOTES

This function is available with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.